{
 "cells": [
  {
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "Source： https://spikingjelly.readthedocs.io/zh-cn/latest/activation_based/basic_concept.html"
   ]
  },
  {
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "# 基于激活值的表示方法"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": 1,
   "metadata": {},
   "outputs": [
    {
     "name": "stdout",
     "output_type": "stream",
     "text": [
      "spike = tensor([0., 1., 0., 0., 0., 0., 0., 0.])\n"
     ]
    }
   ],
   "source": [
    "import torch\n",
    "\n",
    "v = torch.rand([8])\n",
    "v_th = 0.5\n",
    "spike = (v >= v_th).to(v)\n",
    "print('spike =', spike)\n",
    "# spike = tensor([0., 0., 0., 1., 1., 0., 1., 0.])"
   ]
  },
  {
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "# 数据格式"
   ]
  },
  {
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "在 spikingjelly.activation_based 中，数据有两种格式，分别为：\n",
    "\n",
    "表示单个时刻的数据，其 shape = [N, \\*]，其中 N 是batch维度，* 表示任意额外的维度\n",
    "\n",
    "表示多个时刻的数据，其 shape = [T, N, \\*]，其中 T 是数据的时间维度， N 是batch维度，* 表示任意额外的维度"
   ]
  },
  {
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "# 步进模式"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": 17,
   "metadata": {},
   "outputs": [],
   "source": [
    "import torch\n",
    "from spikingjelly.activation_based import neuron\n",
    "\n",
    "net = neuron.IFNode(step_mode='m')\n",
    "# 'm' is the multi-step mode\n",
    "net.step_mode = 's'\n",
    "# 's' is the single-step mode"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": 36,
   "metadata": {},
   "outputs": [
    {
     "name": "stdout",
     "output_type": "stream",
     "text": [
      "tensor([[[[[0., 0., 0., 0., 0.],\n",
      "           [0., 0., 0., 0., 0.],\n",
      "           [0., 0., 0., 0., 0.],\n",
      "           [0., 0., 0., 0., 0.],\n",
      "           [0., 0., 0., 0., 0.]],\n",
      "\n",
      "          [[0., 0., 0., 0., 0.],\n",
      "           [0., 0., 0., 0., 0.],\n",
      "           [0., 0., 0., 0., 0.],\n",
      "           [0., 0., 0., 0., 0.],\n",
      "           [0., 0., 0., 0., 0.]],\n",
      "\n",
      "          [[0., 0., 0., 0., 0.],\n",
      "           [0., 0., 0., 0., 0.],\n",
      "           [0., 0., 0., 0., 0.],\n",
      "           [0., 0., 0., 0., 0.],\n",
      "           [0., 0., 0., 0., 0.]]]],\n",
      "\n",
      "\n",
      "\n",
      "        [[[[0., 1., 0., 1., 0.],\n",
      "           [0., 0., 0., 1., 0.],\n",
      "           [1., 1., 1., 0., 0.],\n",
      "           [1., 1., 1., 1., 1.],\n",
      "           [1., 0., 1., 1., 1.]],\n",
      "\n",
      "          [[1., 1., 0., 1., 0.],\n",
      "           [1., 1., 0., 0., 1.],\n",
      "           [1., 1., 1., 0., 1.],\n",
      "           [0., 0., 0., 0., 0.],\n",
      "           [1., 0., 1., 1., 0.]],\n",
      "\n",
      "          [[0., 1., 0., 1., 0.],\n",
      "           [1., 0., 1., 1., 1.],\n",
      "           [0., 0., 0., 0., 1.],\n",
      "           [0., 0., 0., 0., 0.],\n",
      "           [1., 0., 0., 0., 0.]]]]])\n"
     ]
    }
   ],
   "source": [
    "import torch\n",
    "from spikingjelly.activation_based import neuron\n",
    "\n",
    "net_s = neuron.IFNode(step_mode='s')\n",
    "T = 2\n",
    "N = 1\n",
    "C = 3\n",
    "H = 5\n",
    "W = 5\n",
    "x_seq = torch.rand([T, N, C, H, W])\n",
    "y1_seq = []\n",
    "for t in range(T):\n",
    "    x = x_seq[t]  # x.shape = [N, C, H, W]\n",
    "    y = net_s(x)  # y.shape = [N, C, H, W]\n",
    "    y1_seq.append(y.unsqueeze(0))\n",
    "\n",
    "y1_seq = torch.cat(y1_seq)\n",
    "# y_seq.shape = [T, N, C, H, W]\n",
    "print(y1_seq)"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": 37,
   "metadata": {},
   "outputs": [
    {
     "name": "stdout",
     "output_type": "stream",
     "text": [
      "tensor([[[[[0., 0., 0., 0., 0.],\n",
      "           [0., 0., 0., 0., 0.],\n",
      "           [0., 0., 0., 0., 0.],\n",
      "           [0., 0., 0., 0., 0.],\n",
      "           [0., 0., 0., 0., 0.]],\n",
      "\n",
      "          [[0., 0., 0., 0., 0.],\n",
      "           [0., 0., 0., 0., 0.],\n",
      "           [0., 0., 0., 0., 0.],\n",
      "           [0., 0., 0., 0., 0.],\n",
      "           [0., 0., 0., 0., 0.]],\n",
      "\n",
      "          [[0., 0., 0., 0., 0.],\n",
      "           [0., 0., 0., 0., 0.],\n",
      "           [0., 0., 0., 0., 0.],\n",
      "           [0., 0., 0., 0., 0.],\n",
      "           [0., 0., 0., 0., 0.]]]],\n",
      "\n",
      "\n",
      "\n",
      "        [[[[0., 1., 0., 1., 0.],\n",
      "           [0., 0., 0., 1., 0.],\n",
      "           [1., 1., 1., 0., 0.],\n",
      "           [1., 1., 1., 1., 1.],\n",
      "           [1., 0., 1., 1., 1.]],\n",
      "\n",
      "          [[1., 1., 0., 1., 0.],\n",
      "           [1., 1., 0., 0., 1.],\n",
      "           [1., 1., 1., 0., 1.],\n",
      "           [0., 0., 0., 0., 0.],\n",
      "           [1., 0., 1., 1., 0.]],\n",
      "\n",
      "          [[0., 1., 0., 1., 0.],\n",
      "           [1., 0., 1., 1., 1.],\n",
      "           [0., 0., 0., 0., 1.],\n",
      "           [0., 0., 0., 0., 0.],\n",
      "           [1., 0., 0., 0., 0.]]]]])\n"
     ]
    }
   ],
   "source": [
    "from spikingjelly.activation_based import functional\n",
    "net_s.reset()\n",
    "# x_seq = torch.rand([T, N, C, H, W])\n",
    "y2_seq = functional.multi_step_forward(x_seq, net_s)\n",
    "# y_seq.shape = [T, N, C, H, W]\n",
    "print(y2_seq)"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": 38,
   "metadata": {},
   "outputs": [
    {
     "name": "stdout",
     "output_type": "stream",
     "text": [
      "tensor([[[[[0., 0., 0., 0., 0.],\n",
      "           [0., 0., 0., 0., 0.],\n",
      "           [0., 0., 0., 0., 0.],\n",
      "           [0., 0., 0., 0., 0.],\n",
      "           [0., 0., 0., 0., 0.]],\n",
      "\n",
      "          [[0., 0., 0., 0., 0.],\n",
      "           [0., 0., 0., 0., 0.],\n",
      "           [0., 0., 0., 0., 0.],\n",
      "           [0., 0., 0., 0., 0.],\n",
      "           [0., 0., 0., 0., 0.]],\n",
      "\n",
      "          [[0., 0., 0., 0., 0.],\n",
      "           [0., 0., 0., 0., 0.],\n",
      "           [0., 0., 0., 0., 0.],\n",
      "           [0., 0., 0., 0., 0.],\n",
      "           [0., 0., 0., 0., 0.]]]],\n",
      "\n",
      "\n",
      "\n",
      "        [[[[0., 1., 0., 1., 0.],\n",
      "           [0., 0., 0., 1., 0.],\n",
      "           [1., 1., 1., 0., 0.],\n",
      "           [1., 1., 1., 1., 1.],\n",
      "           [1., 0., 1., 1., 1.]],\n",
      "\n",
      "          [[1., 1., 0., 1., 0.],\n",
      "           [1., 1., 0., 0., 1.],\n",
      "           [1., 1., 1., 0., 1.],\n",
      "           [0., 0., 0., 0., 0.],\n",
      "           [1., 0., 1., 1., 0.]],\n",
      "\n",
      "          [[0., 1., 0., 1., 0.],\n",
      "           [1., 0., 1., 1., 1.],\n",
      "           [0., 0., 0., 0., 1.],\n",
      "           [0., 0., 0., 0., 0.],\n",
      "           [1., 0., 0., 0., 0.]]]]])\n"
     ]
    }
   ],
   "source": [
    "import torch\n",
    "from spikingjelly.activation_based import neuron\n",
    "\n",
    "net_m = neuron.IFNode(step_mode='m')\n",
    "# x_seq = torch.rand([T, N, C, H, W])\n",
    "y3_seq = net_m(x_seq)\n",
    "# y3_seq.shape = [T, N, C, H, W]\n",
    "print(y3_seq)"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": 39,
   "metadata": {},
   "outputs": [
    {
     "data": {
      "text/plain": [
       "tensor(True)"
      ]
     },
     "execution_count": 39,
     "metadata": {},
     "output_type": "execute_result"
    }
   ],
   "source": [
    "(y1_seq==y2_seq).all()"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": 40,
   "metadata": {},
   "outputs": [
    {
     "data": {
      "text/plain": [
       "tensor(True)"
      ]
     },
     "execution_count": 40,
     "metadata": {},
     "output_type": "execute_result"
    }
   ],
   "source": [
    "(y1_seq==y3_seq).all()"
   ]
  },
  {
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "# 状态的保存和重置"
   ]
  },
  {
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "在初始化后，IF神经元层的 **v** 会被设置为0，首次给与输入后 **v** 会自动广播到与输入相同的 **shape**。"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": 41,
   "metadata": {},
   "outputs": [
    {
     "name": "stdout",
     "output_type": "stream",
     "text": [
      "IFNode(\n",
      "  v_threshold=1.0, v_reset=0.0, detach_reset=False, step_mode=s, backend=torch\n",
      "  (surrogate_function): Sigmoid(alpha=4.0, spiking=True)\n",
      ")\n",
      "the initial v=0.0\n",
      "x=tensor([0.0433, 0.2922, 0.1178, 0.5836])\n",
      "y=tensor([0., 0., 0., 0.])\n",
      "v=tensor([0.0433, 0.2922, 0.1178, 0.5836])\n"
     ]
    }
   ],
   "source": [
    "import torch\n",
    "from spikingjelly.activation_based import neuron\n",
    "\n",
    "net_s = neuron.IFNode(step_mode='s')\n",
    "x = torch.rand([4])\n",
    "print(net_s)\n",
    "print(f'the initial v={net_s.v}')\n",
    "y = net_s(x)\n",
    "print(f'x={x}')\n",
    "print(f'y={y}')\n",
    "print(f'v={net_s.v}')"
   ]
  },
  {
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "若我们给与一个新的输入，则应该先清除神经元之前的状态，让其恢复到初始化状态，可以通过调用模块的 self.reset() 函数实现："
   ]
  },
  {
   "cell_type": "code",
   "execution_count": 43,
   "metadata": {},
   "outputs": [
    {
     "name": "stdout",
     "output_type": "stream",
     "text": [
      "x=tensor([0.4362, 0.5806, 0.7236, 0.0200])\n",
      "check point 0: v=0.0\n",
      "check point 1: v=tensor([0.4362, 0.5806, 0.7236, 0.0200])\n",
      "check point 2: v=0.0\n",
      "x=tensor([0.0762, 0.6842, 0.9030, 0.0534, 0.1647, 0.3137, 0.7240, 0.4639])\n",
      "check point 3: v=tensor([0.0762, 0.6842, 0.9030, 0.0534, 0.1647, 0.3137, 0.7240, 0.4639])\n"
     ]
    }
   ],
   "source": [
    "import torch\n",
    "from spikingjelly.activation_based import neuron\n",
    "\n",
    "net_s = neuron.IFNode(step_mode='s')\n",
    "x = torch.rand([4])\n",
    "print(f\"x={x}\")\n",
    "print(f'check point 0: v={net_s.v}')\n",
    "y = net_s(x)\n",
    "print(f'check point 1: v={net_s.v}')\n",
    "net_s.reset()\n",
    "print(f'check point 2: v={net_s.v}')\n",
    "x = torch.rand([8])\n",
    "print(f\"x={x}\")\n",
    "y = net_s(x)\n",
    "print(f'check point 3: v={net_s.v}')"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": null,
   "metadata": {},
   "outputs": [],
   "source": []
  }
 ],
 "metadata": {
  "kernelspec": {
   "display_name": "Python 3 (ipykernel)",
   "language": "python",
   "name": "python3"
  },
  "language_info": {
   "codemirror_mode": {
    "name": "ipython",
    "version": 3
   },
   "file_extension": ".py",
   "mimetype": "text/x-python",
   "name": "python",
   "nbconvert_exporter": "python",
   "pygments_lexer": "ipython3",
   "version": "3.9.19"
  }
 },
 "nbformat": 4,
 "nbformat_minor": 4
}
